<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>BasicYearDateTimeField xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/goda/time/chrono/BasicYearDateTimeField.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time.chrono;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeFieldType;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DurationField;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.goda.time.field.FieldUtils;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.goda.time.field.ImpreciseDateTimeField;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment">/**</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * A year field suitable for many calendars.</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> *</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * @author Guy Allard</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * @since 1.1, refactored from GJYearDateTimeField</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> */</em>
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">class</strong> <a href="../../../../org/goda/time/chrono/BasicYearDateTimeField.html">BasicYearDateTimeField</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/goda/time/field/ImpreciseDateTimeField.html">ImpreciseDateTimeField</a> {
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Serialization version. */</em>
<a name="34" href="#34">34</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = -98628754872287L;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The underlying basic chronology. */</em>
<a name="37" href="#37">37</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/goda/time/chrono/BasicChronology.html">BasicChronology</a> iChronology;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>      <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">     * Restricted constructor.</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     * </em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">     * @param chronology  the chronology this field belogs to</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     */</em>
<a name="44" href="#44">44</a>      <a href="../../../../org/goda/time/chrono/BasicYearDateTimeField.html">BasicYearDateTimeField</a>(<a href="../../../../org/goda/time/chrono/BasicChronology.html">BasicChronology</a> chronology) {
<a name="45" href="#45">45</a>          <strong class="jxr_keyword">super</strong>(DateTimeFieldType.year(), chronology.getAverageMillisPerYear());
<a name="46" href="#46">46</a>          iChronology = chronology;
<a name="47" href="#47">47</a>      }
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isLenient() {
<a name="50" href="#50">50</a>          <strong class="jxr_keyword">return</strong> false;
<a name="51" href="#51">51</a>      }
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> get(<strong class="jxr_keyword">long</strong> instant) {
<a name="54" href="#54">54</a>          <strong class="jxr_keyword">return</strong> iChronology.getYear(instant);
<a name="55" href="#55">55</a>      }
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> add(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> years) {
<a name="58" href="#58">58</a>          <strong class="jxr_keyword">if</strong> (years == 0) {
<a name="59" href="#59">59</a>              <strong class="jxr_keyword">return</strong> instant;
<a name="60" href="#60">60</a>          }
<a name="61" href="#61">61</a>          <strong class="jxr_keyword">int</strong> thisYear = get(instant);
<a name="62" href="#62">62</a>          <strong class="jxr_keyword">int</strong> newYear = FieldUtils.safeAdd(thisYear, years);
<a name="63" href="#63">63</a>          <strong class="jxr_keyword">return</strong> set(instant, newYear);
<a name="64" href="#64">64</a>      }
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> add(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">long</strong> years) {
<a name="67" href="#67">67</a>          <strong class="jxr_keyword">return</strong> add(instant, FieldUtils.safeToInt(years));
<a name="68" href="#68">68</a>      }
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> addWrapField(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> years) {
<a name="71" href="#71">71</a>          <strong class="jxr_keyword">if</strong> (years == 0) {
<a name="72" href="#72">72</a>              <strong class="jxr_keyword">return</strong> instant;
<a name="73" href="#73">73</a>          }
<a name="74" href="#74">74</a>          <em class="jxr_comment">// Return newly calculated millis value</em>
<a name="75" href="#75">75</a>          <strong class="jxr_keyword">int</strong> thisYear = iChronology.getYear(instant);
<a name="76" href="#76">76</a>          <strong class="jxr_keyword">int</strong> wrappedYear = FieldUtils.getWrappedValue
<a name="77" href="#77">77</a>              (thisYear, years, iChronology.getMinYear(), iChronology.getMaxYear());
<a name="78" href="#78">78</a>          <strong class="jxr_keyword">return</strong> set(instant, wrappedYear);
<a name="79" href="#79">79</a>      }
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> set(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> year) {
<a name="82" href="#82">82</a>          FieldUtils.verifyValueBounds
<a name="83" href="#83">83</a>              (<strong class="jxr_keyword">this</strong>, year, iChronology.getMinYear(), iChronology.getMaxYear());
<a name="84" href="#84">84</a>          <strong class="jxr_keyword">return</strong> iChronology.setYear(instant, year);
<a name="85" href="#85">85</a>      }
<a name="86" href="#86">86</a>  
<a name="87" href="#87">87</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getDifferenceAsLong(<strong class="jxr_keyword">long</strong> minuendInstant, <strong class="jxr_keyword">long</strong> subtrahendInstant) {
<a name="88" href="#88">88</a>          <strong class="jxr_keyword">if</strong> (minuendInstant &lt; subtrahendInstant) {
<a name="89" href="#89">89</a>              <strong class="jxr_keyword">return</strong> -iChronology.getYearDifference(subtrahendInstant, minuendInstant);
<a name="90" href="#90">90</a>          }
<a name="91" href="#91">91</a>          <strong class="jxr_keyword">return</strong> iChronology.getYearDifference(minuendInstant, subtrahendInstant);
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DurationField.html">DurationField</a> getRangeDurationField() {
<a name="95" href="#95">95</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isLeap(<strong class="jxr_keyword">long</strong> instant) {
<a name="99" href="#99">99</a>          <strong class="jxr_keyword">return</strong> iChronology.isLeapYear(get(instant));
<a name="100" href="#100">100</a>     }
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getLeapAmount(<strong class="jxr_keyword">long</strong> instant) {
<a name="103" href="#103">103</a>         <strong class="jxr_keyword">if</strong> (iChronology.isLeapYear(get(instant))) {
<a name="104" href="#104">104</a>             <strong class="jxr_keyword">return</strong> 1;
<a name="105" href="#105">105</a>         } <strong class="jxr_keyword">else</strong> {
<a name="106" href="#106">106</a>             <strong class="jxr_keyword">return</strong> 0;
<a name="107" href="#107">107</a>         }
<a name="108" href="#108">108</a>     }
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DurationField.html">DurationField</a> getLeapDurationField() {
<a name="111" href="#111">111</a>         <strong class="jxr_keyword">return</strong> iChronology.days();
<a name="112" href="#112">112</a>     }
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMinimumValue() {
<a name="115" href="#115">115</a>         <strong class="jxr_keyword">return</strong> iChronology.getMinYear();
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaximumValue() {
<a name="119" href="#119">119</a>         <strong class="jxr_keyword">return</strong> iChronology.getMaxYear();
<a name="120" href="#120">120</a>     }
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> roundFloor(<strong class="jxr_keyword">long</strong> instant) {
<a name="123" href="#123">123</a>         <strong class="jxr_keyword">return</strong> iChronology.getYearMillis(get(instant));
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> roundCeiling(<strong class="jxr_keyword">long</strong> instant) {
<a name="127" href="#127">127</a>         <strong class="jxr_keyword">int</strong> year = get(instant);
<a name="128" href="#128">128</a>         <strong class="jxr_keyword">long</strong> yearStartMillis = iChronology.getYearMillis(year);
<a name="129" href="#129">129</a>         <strong class="jxr_keyword">if</strong> (instant != yearStartMillis) {
<a name="130" href="#130">130</a>             <em class="jxr_comment">// Bump up to start of next year.</em>
<a name="131" href="#131">131</a>             instant = iChronology.getYearMillis(year + 1);
<a name="132" href="#132">132</a>         }
<a name="133" href="#133">133</a>         <strong class="jxr_keyword">return</strong> instant;
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> remainder(<strong class="jxr_keyword">long</strong> instant) {
<a name="137" href="#137">137</a>         <strong class="jxr_keyword">return</strong> instant - roundFloor(instant);
<a name="138" href="#138">138</a>     }
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <em class="jxr_javadoccomment">/**</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * Serialization singleton</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     */</em>
<a name="143" href="#143">143</a>     <strong class="jxr_keyword">private</strong> Object readResolve() {
<a name="144" href="#144">144</a>         <strong class="jxr_keyword">return</strong> iChronology.year();
<a name="145" href="#145">145</a>     }
<a name="146" href="#146">146</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

